Mac Magazin/MacEasy 43/Mac Magazin and MacEasy Magazine CD - Issue 43.iso/Software/Mobiles Büro/Newton/Newton Utilities/NewtDB 1.3 ƒ/Newton Script Spport/Newton Script.txt

Text File | 1997-11-28 | 31KB | 830 lines

NewtDb Newton Script       copyright 1997 by Dave Pompea, DMP Systems  v1.12 11/28/97
======================================================================================

1.0 W A R N I N G

2.0 Entering Newton Sript code
    2.1 The NS window
    2.2 Errors when Compiling
    2.3 Errors when executing

3.0 Newton Script 101
    3.1 Variables
    3.2 Math
    3.3 Saving Vars
    3.4 Conditional Statements
    3.5 Detecting Errors
    3.6 Soups, Cursors and Entries
    3.7 Looping


4.0 Predefined Functions and Methods

4.1 Database functions
    4.1.1 DbNameToNumber
    4.1.2 GetFieldNames
    4.1.3 GetCursor
    4.1.4 GetEntry
    4.1.5 NextEntry
    4.1.6 ResetCursor
    4.1.7 GetDbIndirectRecord
    4.1.8    MatchData
    4.1.9 SaveEntry

4.2 Field Functions
 4.2.1 FieldNameToNumber
    4.2.2 GetField
    4.2.3 SetField

4.3 Misc. functions
    4.3.1 FormDateString
    4.3.2 Show
    4.3.3 ShowError
    4.3.4    ToString
 4.3.5 ToNumber
    4.3.6 SaveNsVar
    4.3.7 UpdateDisplay

4.4 ROM functions
 4.4.1 SubStr
 4.4.2 HourMinute

5.0 Getting information from the Names soup
    5.1 GetNamesInfo

6.0 Making a Note in the NotePad
 6.1 MakeNote

7.0 Other built in variables
    7.1 ButtonHit
    7.2 CurrentDbCursor
    7.3 CurrentDb
    7.4 CurrentDbEntry
    7.5 DataformClick
    7.6 FirstTimeFlag
    7.7 LastEditField,LastEditDb
    7.8 NsError
    7.9 NSDontClick
    7.10 RecordAction
    7.11 UpdateFromNS

Appendex A - NsError values
Appendex B - Release notes



1.0 W A R N I N G
=================

If you put Newton Script objects on your screens, the previous version  (v1.25 and below) of NewtDb and UtilityDb will not be able to be used as you will get errors.   So, make a backup of your Newton before experimenting with Newton Script.  Just in case.

You can, of course, delete all Newton Script Screen Objects and then all will be well if using a previous version of NewtDb or UtilityDb.


2.0 Entering Newton Sript code
==============================

2.1 The NS window
-----------------

You make a NS Screen Object by pressing the 'N' button and then selecting "Newton Script". Press the 'E' (for Edit) or double tap the object to open the edit window for it.

Button Text: Define a Label to show up on the screen.

Run Script Always: Check this to have the script execute whenever the screen is updated when viewing different records. i.e., when scrolling, after an edit, changing back to Detail View . If not checked, the code will be run only when the NS button is pressed. If you have set the variable NSDontClick to TRUE then the script will not be run when the button is pressed.

Code:  Enter your NS code here.

Db/Fl button: Press to see a list of all databases and the fields in them. Select a database and it will be pasted into the code. Then, on the next press of this button, the fields for that database will show. Note: If you just wanted to first see the fields of a database, press UnDo to delete the database name text that was pasted into the code.

func(x) button:  Press the to see all the functions  / variables / other defined so you don't have to type them in. Select from this list to paste it at the insertion point.

Check button: Use this to check your code for syntax errors. If there are any, the line number will be shown. The line number is not as you see the lines of code on the screen, but rather where you have put a <cr> (return) at the end of each line.

[A] button: Used to select all text. Note: I discovered that you can also select all text using the TAB key.

Up and Down arrows: Removed in v1.26b3. Use Newton's scroll arrows.


2.2 Errors when Compiling
-------------------------

When you press the 'check' button or close the Newton Script window, the code is compiled. If there are any errors, the possible error line will be selected and an error message displayed. Sometimes the error message will tell you exactly what is wrong. Sometimes not exactly. The messages are the same as a programmer sees.

The line selected may or may not be the line in error. Sometimes it's the line above the selected line as the compiler is still scanning text is search of a valid line of code.

If the error text is the last line, then the error may be well above it. Some causes are unmatched quotes, unbalanced parentheses or a missing END statement.

2.3 Errors when executing
-------------------------

When your code executes, the NsError variable will be NIL until a detectable error happens. Then, when a detectable error happens, NsError will be set to a number and the data returned from the function will be NIL if an object is expected to be returned, 0 if a number is expected and an empty string ("") if a string is expected.

When an undetectable error happens, you will get the normal error box on the screen with the Newton Script title you gave your code, the Newton O/S error number and for common errors, an explantaion of the error. You also might get the variable or function name that is the cause of the error. You might also get the last NsError code that was encountered, if there was one.

Until your code is fully debuged, you might want to sprinkle :show("step_xxx_Im_here") statements in your code so that you can see what the last executed command was.

Another way to see what statement is in error is to set the NsError var yourself to a negative number after each statement. That way, the error box will show you that number and you'll know which statement caused the error. But remember that a detectable error will set the NsError variable to a positive number.

Example:

local X := "test";
NsError := -1;
X := X + 1;
NsError := -2;
X := Z + 1;                // this would cause an error if Z is not defined, ie NIL. It will show "NsError = -2" in the error box.




3.0 Newton Script 101
=====================

For basic Newton Script information, surf over to Fundamentals of NewtonScript at http://www.newton-inc.com/dev/techinfo/ProgNewtUsingMac/ProgNewt-77.html and Programming for the Newton at http://www.newton-inc.com/dev/techinfo/ProgNewtUsingMac/ProgNewt-1.html


All logical lines of code end in a ';' - a semi colon.

Comments in code are proceeded with '//' - two slashes. This will comment out anything up to the next <cr>.

Assignments use ':=' to separate left and right sides:      ATotal := ATotal + 1;

To put two (or more) vars that hold text into one var, use the '&' operator:  a := "me";  b := " and ";  c:= "you";  d := a & b & c;
D now contains "me and you".


Functions and methods (unless they are Global, ie in the Newton Rom) have a colon if front of them:

:Show("some_text");




3. 1 Variables
--------------

Variables start with a letter, have NO embedded spaces and are NOT case sensitive. You cannot use a '.' (period) in a variable name.

If you need (and you will) variables in your code, define them with a 'Local' statement:
Local SomeVar;
Local SomeVar := nil;
Local SomeVar := 10;

Local variables are not saved between executions of your code. To save variables you need to put them in a frame that will be saved, even after closing NewtDb. You do not have to "type" type variables. In other words, you do not have to define a variable as string (text) or integer or real. A variable can hold any type of information.


3.2 Math
--------

All the normal arithmetic operators are in Newton Script.



3.3 Saving Vars
---------------

To save a variable so that it's value is available the next time the code is executed, attach it to the variable NSvar. NSvar is a frame (kind of like a record in Pascal or a structure in C ) that can hold as many variables (up to 32k bytes in size) as you want. Since the NSvar is accessable to all your Newton Script code Screen Objects, you can set information in it in one code script and get at that information in another code script.

To save your attached variables, do a :SaveNsVar(); method at the end of your script. If you do not, then your vriables may not be saved.  The NSvar frame is actually saved in the NewtDb Preferences soup entry.

Example:

Local PartTotal;                       // declare the var
If NSvar.PTotal <> nil then      // PartTotal has  been saved as it is defined (ie not NIL).
     PartTotal := NSvar.PTotal;  // so get it's value
  else                           // otherwise ...
     PartTotal := 0;             // initialize it
// do some calculations here
NSvar.PTotal := PartTotal;       // set the var into the NSvar frame
:SaveNsVar();                    // tell NewtDb to save it



You attach a variable to the NSvar variable by using the dot constructor:

NSvar.PTotal := PartTotal;    // set the var into the NSvar frame

You can reference the saved variable the same way, but you realy should check for its existance first:

If NSvar.PTotal <> nil then PartTotal := NSvar.PTotal;



3.4 Conditional Statements
--------------------------

They have the form of:

IF expression THEN statement {ELSE statement}


Where expression can be a logical comparison of two variables or just one variable evaluated to see if it's true.

"statement" can be just one , single statement or multiple statement surrounded by "BEGIN" and "END;"
The BEGIN / END; pair indicate that more than one statement is to be executed.

Only integers and symbols can be compared for equality. To compare text use the function StrEqual(a,b), which returns TRUE if both text strings are the same. StrEqual is not case sensitive.

Examples:

If MyVar then count := count +1;    // checks that 'MyVar' is not nil

If NOT MyVar then count := count +1;    // checks that 'MyVar' is  nil

If MyVar = 3 then  count := count +1;

If MyVar = 3 then  count := count +1;  else count = 0;

If MyVar = 3 then
   begin
        count := count +1;
        total := total + item;
   end;

If (MyVar = 3) and (item > 100) then
   begin
        count := count +1;
        total := total + item;
   end;
   else begin
      count := 0;
      total := 0;
   end;


Relational operators include: =, <>, >, <, <=, and >=  .
You can use AND or OR to group expressions. You can use the keyword NOT to negate.

If you use an ELSE statment, it is tied to the last IF statment before it.


3.5 Detecting Errors
--------------------

The built in variable NSError will be normally be NIL if all is OK.  If one of the built in function spots an error in the parameters you pass it, it willbne set to a numer (ie NOT NIL)  If it is not NIL (an error occured) , you will need to reset it to nil for later use inside the script to detect later errors.

See the NsError number list at the end of this document.

Example:
local aDbNumber := 999;     // bogus as  database #999 surely does not exist
:GetFieldNames(aDbNumber);   // try to get the field names of Db #999, this will set NSError to 2.
if NSError then .....       // check for the error, it will be non NIL if there has been an error.

NSError will not be NIL as the function GetFieldNames checks the DbNumber and 999 is surely more than the maximum allowed.


3.6 Soups, Cursors and Entries
------------------------------

We all know what a Soup is, right ? It's that thing in the Storage folder (in Extras) that holds information. You'll need to know the Database Number to access the records in the soups. The Database number is the one you selected when you made the database. Database numbers start at 0 and go to 15 (Right now. In the future it will be 63). You can also use the Database Name to find out the number.

To get a record from the database, you need to tell Newton which one you would like to work with. This is called a Cursor. Like the cursor on your screen, it points to a record in a soup.

But a Cursor only points to a record. To get that record, it needs be retrieved. When you retrieve a record from where the Cursor is pointing, it's called an Entry. This entry is what you work with to get at the data in the record.


So,  to get the first record, it would look something like this:

Local MyDatabaseNumber  :=  :DbNameToNumber("PartsDb");         // get the Db number from it name
Local MyCursor := :GetCursor(MyDatabaseNumber,0 );    //get a cursor for the database using Index 0
Local MyEntry := :GetEntry(MyCursor);      // get the record that the cursor is pointing to


'MyEntry' now contains the first record in the database and can be used by other functions to get or change the data in each field:

local FieldNumber := 2;
Local name := :GetField(MyEntry, FieldNumber);   //  gets the data from field #2 and put it in var 'name'

To get subsequent records use:

MyEntry :=  :NextEntry(MyCursor);     // this will point the cursor at the next record and fetch it

To test if you have come to the end of the database (no more records) , see if the Entry is not nil:

If MyEntry  then  ....     // if there is a record, then this will evaluate to other than NIL


3.7 Looping
-----------

Newton Script doesn't have a GOTO Label type function, so you have to use the WHILE DO  construct to loop.

Example:

x := 0
While x < 10 do
    begin
        x := x + 1;
       total := total + item;
   end;

Or you can use a FOR loop. Which works just like a FOR loop in Basic and is kind of close to FORTRAN and, thank goodness, nothing like C.

Example:

For i := 1 to 10 by 1 do
    begin
        x := x + 1;
       total := total + item;
   end;

The "by 1" is optional. The above will loop setting the var 'i' to 1, incrementing it at the end, until it reaches 10.





4.0 Predefined Functions and Methods
====================================

There are many functions defined for you so that you don't have to know how records are stored. Functions return a result. Methods do not. Both must have their name proceeded by a ':' (colon) or you will get a -48808 error (Undefined global function) when the code is run.

Each function is shown as it is entered with any variables needed, an explanation of the function and the variables types needed and the data (if any) returned.

4.1 Database functions
----------------------

4.1.1 DbNameToNumber

:DbNameToNumber(DbName)

Returns:  the Number of a database when supplied the name of it.
DbName: a text string


4.1.2 GetFieldNames

:GetFieldNames(DbNumber)

Returns: an array (FieldNameArray) of field names of a database.
DbNumber: a database number


4.1.3 GetCursor

:GetCursor(DbNumber, IndexNumber)

Returns: a Cursor object
DbNumber: a database number
IndexNumber:  an index number (0-2, currently)


4.1.4 GetEntry

:GetEntry(DbCursor)

Used to fetch the current record that is pointed to by the cursor.

Returns: a database record
DbCursor:  a Cursor object


4.1.5 NextEntry

:NextEntry(DbCursor)

Advances the cursor to the next record in the database and gets that record.

Returns:  the next database record
DbCursor:  a Cursor object


4.1.6 ResetCursor

:ResetCursor(DbCursor)

Resets the Cursor so that it points to the first record in a database.
DbCursor:  a Cursor object


4.1.7 GetDbIndirectRecord

:GetDbIndirectRecord(DbNumber, MatchFieldNumber, MatchDataStr)

Fetches any record from any database. The database (DbNumber) is searched to find a record that has MatchDataStr in its MatchFieldNumber field.

Returns: A frame the consists of DbEntry and DbCursor slots:  (DbEntry: xxxx , DbCursor: yyyy). If there is not a match then both DbEntry and DbCursor are set to nil.

DbNumber: The database to search in.
MatchFieldNumber: The field number to use for matching data.
MatchDataStr: The data to match in MatchFieldNumber. It is not case sensitive.
Further entries (as referenced by DbCursor returned) the will NOT be qualified per the original match data. However, if the MatchFieldNumber is an index then further records returned by using the DbCursor will be sorted as specified by the index.

Note: This function has changed since the original (v1.26b1) release. The result is now a frame and the DbCursor var is NOT passed.

Example:

local DbNumber := 6;
local MatchFieldNumber := 0;
local MatchDataStr := "D";
local MyFrame := :GetDbIndirectRecord(DbNumber, MatchFieldNumber, MatchDataStr)

local MyDbEntry := MyFrame.DbEntry;   // get the record returned
local MyDbCursor := MyFrame.DbCursor;  // get the cursor returned


The above searches Db #6 in field #0 for data starting with a "D". If found, then the record entry and cursor to it are returned in MyFrame.


4.1.8    MatchData

:MatchData(DbEntry, FieldNumber, MatchDataStr)

Use to check if a record (DbEntry) contains the data (MatchDataStr) in field:  FieldNumber.

Returns: NIL if MatchDataStr is NOT the data in the  field (FieldNumber), otherwise TRUE.
DbEntry: a database record
FieldNumber: the field number to use
MatchDataStr: the text data to match


4.1.9 SaveEntry

:SaveEntry(DbEntry)


Sets a flag to have NewtDb save the record to the soup. If you do not call this method, any changed data may not be saved.

DbEntry: the database record


4.2 Field Functions

4.2.1 FieldNameToNumber

:FieldNameToNumber(FieldNameArray,FieldName)

Lets you get a field number of any database when you provide the text name of the field.

Returns: field number
FieldNameArray: Array from GetFieldNames()
FieldName: text name of a field


4.2.2 GetField

:GetField(DbEntry, FieldNumber)

Extracts the field data from a database record.

Returns: The field data from a record
DbEntry: a database record
FieldNumber: the field number of the data to get


4.2.3 SetField

:SetField(DbNumber, DbEntry, FieldNumber, aString)

Puts data into a database record.

DbNumber: The database number
DbEntry: The database record
FieldNumber: the field number of where to put the data into
aString: the data  to be put in the record




4.3 Misc. functions

4.3.1 FormDateString

:FormDateString(time())


Returns a Date text string, formatted as you have specified in NewtDb->[i]->prefs->Date Format.
Normally you feed if a "time()" method. Time() returns time in minutes since 1904. If you need to calculate times, use  :ToString(time()) and put that text number in a field. Then use that number ( :ToNumber(aString)  ) to convert to a number, calculate a new date, and put the date on screen in the NS object.


4.3.2 Show

:Show(aString)

Takes a text string (aString) and puts that text into the Newton Script Button on the screen.


4.3.3 ShowError

:ShowError(aString)

Takes a text string (aString) and makes it into an Error Dialog box. Like all the -xxxxx errors you see that pop up when a program goes kablooie.


4.3.4    ToString

:ToString(aNumber)


Converts a number to a text string. NewtDb stores all data as text. After a calculation, convert a number to text with this if you want to put it in a record or display.
Returns: a text string
aNumber: a number. It can be a real or integer.


4.3.5 ToNumber

:ToNumber(aString)

Converts text to a number. NewtDb stores all data as text. To use in a calculation, you must convert it to a number.
Returns: a number. It may be real (123.456) or an integer (123) depending on the data
aString: text form of a number: "123.456" , "-3", "1e22"

If a blank (empty) string is passed, a zero is returned.


4.3.6 SaveNsVar

:SaveNsVar()

Sets the flag telling NewtDb to save any Newton Script (NOT Local vars) vars (NsVar.xxx) to soup so they can be used the next time NewtDb is started. See  Saving Vars.


4.3.7 UpdateDisplay

:UpdateDisplay()

Forces NewtDb to update the screen. Just as if you pressed a scroll button to get another record on the screen or after an Edit.  Useful ONLY when you have changed a value in a Database field that is displayed on the screen and you want the screen to show it. Be sure to use :SaveEntry(DbEntry)  first !

Other Newton Script Screen Objects will be executed when UpdateDisplay is executed. The script from which UpdateDisplay was called in will not be executed again. Otherwise a loop would result.

Everytime UpdateDisplay is executed, all the data on the screen is updated so doing this can be an expensive CPU cycle eater. If you have multiple scripts that need to UpdateDisplay, try putting only one UpdateDisplay in the last script to be executed. You determine the order of  Screen Objects being updated by using the Move to Front / Back button in UtilityDb. Front most objects are executed / updated last.

If you do not want the other Newton Script objects to execute when UpdateDisplay is called, put a test in the scripts for the variable UpdateFromNS which is set to TRUE if an UpdateDisplay is in effect:

If UpdateFromNS then return;     // no need to run this script as screen is being refreshed by another Newton Script Object.


4.4 ROM functions

4.4.1 SubStr

SubStr(aString,startPos, NumberChars)

Returns a part of a string(text) var. Works just like MID$ in Basic.

aString - a text string
startPos - the starting position in the string to start extracting from. Strings start at 0.
NumberChars - number of characters to extract. Use nil to get all characters to the end of the string.

Examples:

SubStr("abcdefg", 2,2) returns "cd"
SubStr("abcdefg", 2,nil) returns "cdedf"


4.4.2 HourHinute

HourMinute(time)

Returns a string that has the time formated as "HH:MM Xm" or whatever your local is set to.

time - a valid time number. Use time() for the current time.



5.0 Getting information from the Names soup

5.1 GetNamesInfo

:GetNamesInfo(MatchStr)

Gets a record from the Names soup

Returns: a Names soup frame or nil if not found.
MatchStr: text that is used to match an entry in the Names soup. This data is matched to the 'sorton slot , which is normally the Name or Company.

The data in this frame is:

[see the Names Soup Format document for details]

Example:

Local aNameRecord := :GetNamesInfo("Pompea"); // that's me you're looking up
local aCity := aNameRecord.city;  // get the city for me
:Show("Dave lives in " & aCity);  // show it on the screen, where the NS button is.




6.0 Making a Note in the NotePad

6.1 MakeNote

:MakeNote(aString)

Takes aString and makes a Note in the NotePad of it. You can put up to 8,000 characters of text into a Note. You may include <cr>'s (unix new lines) by using a \n in the text and tabs as  \t . Please see the example code for formatting data for the NotePad when you use tabs.




7.0 Other built in items
========================

7.1 ButtonHit

ButtonHit

A Var that indicates that this Newton Script code is being executed because the user pressed  it's button on the screen. Also see: NSDontClick.

7.2 CurrentDbCursor

CurrentDbCursor

CurrentDbCursor is a variable of type  DbCursor and is the same one used for the record being show on the screen. It is the same as ":GetCursor(DbNumber, IndexNumber)" except you don't have to know the database number and the index is the same as you have set on the screen. And it will only fetch records qualified by  your on screen Query , if you have the Query! set on.

CurrentDbCursor initially points to the current screen record, so you should do something like:

local myCursor := CurrentDbCursor;
 :ResetCursor(myCursor);            // now points to the first record in the datatbase, or first matching record if Query is on.

If you need to always know the current screen record, make a copy of it first:

local myCursor := CurrentDbCursor:clone();  // makes a copy of the screen cursor, leaving CurrentDbCursor pointing at current record
 :ResetCursor(myCursor);            // now points to the first record in the datatbase, or first matching record if Query is on.

Note: Do Not use CurrentDbCursor in a PickActionScript or any other defered / delayed call as it's not valid after the main code executes. If you realy do need it under these conditions, copy it to the NSVar frame and remember to nil out that var after use.


7.3 CurrentDb

CurrentDb

A var that holds the number of the database being viewed on the screen. Can be used in place of:

local TheDb := :DbNameToNumber("current_screen_Db_Name")

when you are working with records in the current screen being displayed and you don't want to hard code the database number.


7.4 CurrentDbEntry

CurrentDbEntry


A var holds the current database record that is seen on the screen.
You can use this in place of DbEntry as shown in the following examples:

local DbCursor := CurrentDbCursor;
local DbEntry := :GetEntry(DbCursor);

or

local DbCursor := :GetCursor(DbNumber,index);
local DbEntry := :GetEntry(DbCursor);

or (even more verbose)

local index := 0;
local DbNumber := :DbNameToNumber("Names Db");
local DbCursor := :GetCursor(DbNumber,index);
local DbEntry := :GetEntry(DbCursor);


in all above cases the DbEntry var is the same as the CurrentDbEntry var.


7.5 DataformClick

DataformClick


A variable that can be examined to see if any field on the screen is being edited. DataformClick will be equal to 1 if a field is being edited, 0 if not.


7.6 FirstTimeFlag

FirstTimeFlag

A var that is set to True when the Newton Script code is executed for the first time. i.e.. when the screen containing the NS object is first viewed. It is set to NIL afterwards. NOTE:  NewtDb caches screens. If a screen is unloaded, then loading it again will set the FirstTimeFlag again. This may change in the future so that FirstTimeFlag is TRUE only once.

Note: Do Not use FirstTimeFlag in a PickActionScript or any other defered / delayed call as it's not valid after the main code executes. If you realy do need it under these conditions, copy it to the NSVar frame and remember to nil out that var after use.


7.7 LastEditField,LastEditDb

LastEditField  and LastEditDb vars


Vars that hold the field number and database number of the last field that was edited. Set only when data was changed in an edit. Useful for detecting that some data on the screen changed if you need to know that to update other data. ie update a Total if a field holding the number to be totaled changed.


7.8 NsError

NsError

a var that is NIL if a no error has occured. Set to a non NIL value if a preceeding function (as the ones defined above) found an error. You  need to set to NIL if you need to detect further errors. See the list of values that NsError can be in Appendex A.


7.9 NSDontClick

NSDontClick

Set this variable to TRUE so that a tap in the Newton script window won't make it act like a button. ie hilite and run the script.

With NSDontClick set to TRUE you will be able to select the text displayed and copy it to the clipboard.


7.10 RecordAction

RecordAction


Lets you detect a user action of creating / deleting / duplicating a record.

The Var RecordAction can be:

'NewMain , 'DeleteMain , 'DupMain  for the record being shown - the Main record or:

'NewIndirect , 'DeleteIndirect , 'DupIndirect for any indirect record linked to on the screen.

Example:
if RecordAction <> 'NewMain then return;        // exists code if it the reason for the code executing was not because a new record was made.


NOTE: There is a single quote in front of the values. They are symbols.



7.11 UpdateFromNS

UpdateFromNS

A variable that can be examined to see if the script is being executed because some other script called UpDataDisplay, thus forcing all other Newton Script Screen Objects to also be executed.






Appendex A - NsError values
===========================

The NsError var holds the error number for the last error detected. If it is nil, then no error was detected. Below is the list for error numbers, the routine that it would be generated in and what caused the error.

Error#     Routine                       Explanation

 1 - DbNameToNumber:                Db name is not a string.
 2 - DbNameToNumber:                No Db exists for that name.
 3 - FieldnameToNumber:             Field name is not a string.
 4 - FieldnameToNumber:             No field exists for that name.
 5 - GetCursor:                     Invalid Db number
 6 - GetCursor:                     Invalid index number.
 7-  GetCursor:                     Invalid cursor generated with parameters.
 8 - GetDbIndirectRecord:           Db number out of range.
 9 - GetDbIndirectRecord:           Problem finding a match record / record not found.
10 - GetEntry:                      Problem with Cursor, possibly invalid.
11 - GetField:                      Field number less than zero.
12 - GetField:                      Field number greated than number of fields in the record.
13 - GetFieldNames:                 Invalid Db number.
14 - GetFieldNames:                 Database does not exist.
15 - GetNamesInfo:                  Problem accessing the Names soup. Possible invalid Match data.
16 - MakeNote:                      Problem saving the text to the NotePad. Possible memory full.
17 - MatchData:                     Field number less than zero.
18 - MatchData:                     Entry is not a soup entry.
19 - MatchData:                     Match data is not a string.
20 - MatchData:                     Field number greated than number of fields in the record.
21 - NextEntry:                     Problem fetching entry. Possibly invalid cursor.
22 - ResetCursor:                   Problem reseting cursor. Possibly invalid cursor.
23 - SaveEntry:                     Problem saving the record. Possible store full.
24 - SetField:                      Db number is invalid.
25 - SetField:                      Entry is not a soup entry.
26 - SetField:                      Field number is less than zero.
27 - SetField:                      Field number greated than number of fields in the record.
28 - Show:                          Data is not a string.
29 - ToNumber:                      Data is not a string.
30 - ToNumber:                      Data does not contain a valid number. Or number too large or small.
31 - ToNumber:                      Data did not convert to a number.
32 - ToString:                      Data was not a valid text number.
33 - MatchData:                     Data in the field of the record was not a string.
34 - SaveEntry:                     Record is not a soup entry.
35 - GetField:                      Entry is not a soup entry.
36 - ToString:                      Data was not a number. ie a real or integer.
37 - ToString:                      Data was NIL.
38 - ToNumber:                      String was longer than 32 chars.





Appendex B - Release notes:

1.12 11/28/97
 - added notes for FirstTimeFlag and CurrentDbCursor vars.
 - added Index at start of text.
 - rearainged topics, subtopics.

1.11 - 10/26/97
 - added NsError #38.

1.1 - 9/27/97

- FOR loop text had 'step', not 'by' for loop increment.
- Changed GetDbIndirectRecord() parameters and return value.
- Added NSDontClick variable. See: Run Script Always.
- Added  UpdateFromNS variable.
- Added  DataformClick variable information.
- Changed NsError to return a number vs TRUE and added list of codes.
- Added more information about UpDateDisplay.
- Minor other changes and many explanations added / expanded.

-30-